Public 成员函数 | |
| def | TaggedPDF (doc) |
| 构造函数。 更多... | |
| def | TaggedPDF (other) |
| 带另一个标记PDF对象的构造函数。 更多... | |
| def | GetFigureAlternateText (figure_index) |
| 获取图形的替代文本。 更多... | |
| def | GetFigureCount () |
| 获取标记文档中图形的数量，不包括装饰性图形。 更多... | |
| def | GetFigurePageIndex (figure_index) |
| 根据图形索引获取图形页面索引。 更多... | |
| def | GetFigureRect (figure_index) |
| 获取图形的矩形区域。 更多... | |
| def | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| def | SetAsDecorativeFigure (figure_index) |
| 装饰图形。装饰性图形不能设置替代文本。 更多... | |
| def | SetCallback (callback) |
| 为标记PDF设置回调对象。 更多... | |
| def | SetFigureAlternateText (figure_index, alternate_text) |
| 设置图形替代文本。 更多... | |
| def | StartTagDocument (pause) |
| 使用指定的标记设置开始自动标记给定的PDF文档。 更多... | |
详细描述
此类表示标记PDF文档的设置。标记PDF意味着这里仅针对PDF结构的标记信息。 在使用此模块中的任何类或方法之前，请确保Foxit PDF SDK已通过 FoxitPDFSDKPython2.Library.Initialize 函数使用包含"Accessibility"模块的密钥 成功初始化。
构造及析构函数说明
◆ TaggedPDF() [1/2]
| def FoxitPDFSDKPython2.TaggedPDF.TaggedPDF | ( | doc | ) |
构造函数。
- 参数
-
[in] doc 要标记的有效PDF文档对象。
此构造函数用于构造具有默认设置的标记PDF对象。
◆ TaggedPDF() [2/2]
| def FoxitPDFSDKPython2.TaggedPDF.TaggedPDF | ( | other | ) |
带另一个标记PDF对象的构造函数。
- 参数
-
[in] other 另一个标记PDF对象。
成员函数说明
◆ GetFigureAlternateText()
| def FoxitPDFSDKPython2.TaggedPDF.GetFigureAlternateText | ( | figure_index | ) |
获取图形的替代文本。
替代文本是人类可读的文本，可以通过为图像、公式或其他不能自然转换为文本的项目 提供替代文本来增强PDF文档。 此函数仅用于标记PDF文档。请调用函数 FoxitPDFSDKPython2.PDFDoc.IsTaggedPDF 检查当前PDF文档是否 是标记PDF文档。
- 参数
-
[in] figure_index 图形的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython2.TaggedPDF.GetFigureCount 返回。
- 返回
- 替代描述文本。
◆ GetFigureCount()
| def FoxitPDFSDKPython2.TaggedPDF.GetFigureCount | ( | ) |
获取标记文档中图形的数量，不包括装饰性图形。
此函数仅用于标记PDF文档。请调用函数 FoxitPDFSDKPython2.PDFDoc.IsTaggedPDF 检查当前PDF文档是否 是标记PDF文档。
- 返回
- 图形的数量。
◆ GetFigurePageIndex()
| def FoxitPDFSDKPython2.TaggedPDF.GetFigurePageIndex | ( | figure_index | ) |
根据图形索引获取图形页面索引。
此函数仅用于标记PDF文档。请调用函数 FoxitPDFSDKPython2.PDFDoc.IsTaggedPDF 检查当前PDF文档是否 是标记PDF文档。
- 参数
-
[in] figure_index 图形的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython2.TaggedPDF.GetFigureCount 返回。
- 返回
- 页面索引。有效值从0开始。如果出现任何错误，此函数将返回-1。
◆ GetFigureRect()
| def FoxitPDFSDKPython2.TaggedPDF.GetFigureRect | ( | figure_index | ) |
获取图形的矩形区域。
此函数仅用于标记PDF文档。请调用函数 FoxitPDFSDKPython2.PDFDoc.IsTaggedPDF 检查当前PDF文档是否 是标记PDF文档。
- 参数
-
[in] figure_index 图形的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython2.TaggedPDF.GetFigureCount 返回。
- 返回
- 图形矩形区域。如果出现任何错误，此函数将返回空矩形。
◆ IsEmpty()
| def FoxitPDFSDKPython2.TaggedPDF.IsEmpty | ( | ) |
检查当前对象是否为空。
当当前对象为空时，意味着当前对象无用。
- 返回
- true表示当前对象为空，false表示不为空。
◆ SetAsDecorativeFigure()
| def FoxitPDFSDKPython2.TaggedPDF.SetAsDecorativeFigure | ( | figure_index | ) |
装饰图形。装饰性图形不能设置替代文本。
此函数仅用于标记PDF文档。请调用函数 FoxitPDFSDKPython2.PDFDoc.IsTaggedPDF 检查当前PDF文档是否 是标记PDF文档。
- 参数
-
[in] figure_index 图形的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython2.TaggedPDF.GetFigureCount 返回。
- 返回
- true表示装饰图形成功，false表示不成功。
◆ SetCallback()
| def FoxitPDFSDKPython2.TaggedPDF.SetCallback | ( | callback | ) |
为标记PDF设置回调对象。
如果不调用此函数，意味着不会使用回调。
- 参数
-
[in] callback 由用户实现的TaggedPDFCallback 对象。 用户可以通过此回调在标记PDF文档期间更改一些信息/数据。 请确保回调对象在当前标记PDF对象的生命周期结束之前保持有效。
如果此值为null，意味着使用默认信息/数据。
- 返回
- 无。
◆ SetFigureAlternateText()
| def FoxitPDFSDKPython2.TaggedPDF.SetFigureAlternateText | ( | figure_index, | |
| alternate_text | |||
| ) |
设置图形替代文本。
替代文本是人类可读的文本，可以通过为图像、公式或其他不能自然转换为文本的项目 提供替代文本来增强PDF文档。 此函数仅用于标记PDF文档。请调用函数 FoxitPDFSDKPython2.PDFDoc.IsTaggedPDF 检查当前PDF文档是否 是标记PDF文档。
- 参数
-
[in] figure_index 图形的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython2.TaggedPDF.GetFigureCount 返回。 [in] alternate_text 替代描述文本。
- 返回
- 无。
◆ StartTagDocument()
| def FoxitPDFSDKPython2.TaggedPDF.StartTagDocument | ( | pause | ) |
使用指定的标记设置开始自动标记给定的PDF文档。
如果用户希望在标记文档过程中获取特定的标记结果，请参考函数 FoxitPDFSDKPython2.TaggedPDF.SetCallback 关于回调函数 FoxitPDFSDKPython2.TaggedPDFCallback.Report 。
- 参数
-
[in] pause 暂停对象，决定自动标记过程是否需要暂停。 这可以是null，意味着在标记过程中不暂停。 如果不是null，它应该是用户实现的有效暂停对象。 默认值：null。
- 返回
- 渐进对象。请通过函数FoxitPDFSDKPython2.Progressive.GetRateOfProgress 检查当前进度的比率。如果比率还不是100，调用函数 FoxitPDFSDKPython2.Progressive.Continue 继续进度直到进度完成。
